<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/util.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('util_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">util.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="util_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _UTIL_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _UTIL_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">/** The function is finished gracefully. */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="util_8h.html#a823b9cc14d4c72b7d81ea9754dfaeb59">   12</a></span>&#160;<span class="preprocessor">#define SUCC            (0)</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">/** The data structure is not initialized. */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="util_8h.html#a71927e9402d98a87c5c9eb6111058987">   15</a></span>&#160;<span class="preprocessor">#define ERR_NOINIT      (-1)</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">/** Insufficient memory for data structure expansion or reallocation. */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="util_8h.html#a0b27e89a225080d914772b42c19726cf">   18</a></span>&#160;<span class="preprocessor">#define ERR_NOMEM       (-2)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">/** Invalid argument to index the data structure. */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="util_8h.html#acac8003c163c1000c583be39800c22ba">   21</a></span>&#160;<span class="preprocessor">#define ERR_IDX         (-3)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">/** Duplicated key to insert associative data structures. */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="util_8h.html#ab4fdc531e4f68894ba5caf2dfd5de639">   24</a></span>&#160;<span class="preprocessor">#define ERR_DUPKEY      (-4)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/** No entry can be found with the given key from the associative data structures. */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="util_8h.html#a1b45804a56fa8764461b11f13e5c9bf2">   27</a></span>&#160;<span class="preprocessor">#define ERR_NODATA      (-5)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">/** Invalid argument to store the returned data from getter operation. */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="util_8h.html#a9bebdd917f460e15626723b9053aa628">   30</a></span>&#160;<span class="preprocessor">#define ERR_GET         (-6)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">/** Invalid argument to specify the key size for hash data structures. */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="util_8h.html#a306f92ef75fa539e28087d717fcb3fc8">   33</a></span>&#160;<span class="preprocessor">#define ERR_KEYSIZE     (-7)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">/** Item is the data type for the container element. */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">   37</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">/** Key is the data type to index map-like containers. */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">   40</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">/** Value is the data type for the map-like element. */</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">   43</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">/** Entry is the data type which wraps key value pair to manipulate map-like</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    containers. */</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="util_8h.html#a0f62df023942df493672150257c26348">   47</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">/** Pair is the real key value pair stored in the map-like containers. */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structPair.html">   50</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_Pair {</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structPair.html#aa9f096ba0773753c5fdf1b51133f1b09">   51</a></span>&#160;    <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a> <a class="code" href="structPair.html#aa9f096ba0773753c5fdf1b51133f1b09">key</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structPair.html#a129a6c5ea17c05081dffcb2d8e41a81a">   52</a></span>&#160;    <a class="code" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a> <a class="code" href="structPair.html#a129a6c5ea17c05081dffcb2d8e41a81a">value</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;} <a class="code" href="structPair.html">Pair</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="util_8h_html_ad0d0cb99e46ebc1c0458843e19ae21bd"><div class="ttname"><a href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a></div><div class="ttdeci">const void * Value</div><div class="ttdoc">Value is the data type for the map-like element. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00043">util.h:43</a></div></div>
<div class="ttc" id="util_8h_html_a0f62df023942df493672150257c26348"><div class="ttname"><a href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a></div><div class="ttdeci">const void * Entry</div><div class="ttdoc">Entry is the data type which wraps key value pair to manipulate map-like containers. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00047">util.h:47</a></div></div>
<div class="ttc" id="util_8h_html_a2583da5c1c14184068bda8cf681d5bed"><div class="ttname"><a href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a></div><div class="ttdeci">const void * Item</div><div class="ttdoc">Item is the data type for the container element. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00037">util.h:37</a></div></div>
<div class="ttc" id="structPair_html_aa9f096ba0773753c5fdf1b51133f1b09"><div class="ttname"><a href="structPair.html#aa9f096ba0773753c5fdf1b51133f1b09">Pair::key</a></div><div class="ttdeci">Key key</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00051">util.h:51</a></div></div>
<div class="ttc" id="util_8h_html_ab8673c57cfd615afd06cafefa9c2445e"><div class="ttname"><a href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a></div><div class="ttdeci">const void * Key</div><div class="ttdoc">Key is the data type to index map-like containers. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00040">util.h:40</a></div></div>
<div class="ttc" id="structPair_html_a129a6c5ea17c05081dffcb2d8e41a81a"><div class="ttname"><a href="structPair.html#a129a6c5ea17c05081dffcb2d8e41a81a">Pair::value</a></div><div class="ttdeci">Value value</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00052">util.h:52</a></div></div>
<div class="ttc" id="structPair_html"><div class="ttname"><a href="structPair.html">Pair</a></div><div class="ttdoc">Pair is the real key value pair stored in the map-like containers. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00050">util.h:50</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="util_8h.html">util.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
